Skip to content

[Docs] Correct configuration search paths on Windows#478

Merged
creativeprojects merged 1 commit intocreativeprojects:masterfrom
auxym:windows-paths
Mar 30, 2025
Merged

[Docs] Correct configuration search paths on Windows#478
creativeprojects merged 1 commit intocreativeprojects:masterfrom
auxym:windows-paths

Conversation

@auxym
Copy link
Copy Markdown
Contributor

@auxym auxym commented Mar 30, 2025

Append resticprofile to the AppData and ProgramData paths on Windows.

See

resticprofile/filesearch/filesearch.go

Line 224 in ac3b810

locations = append(locations, filepath.Join(configDir, AppName))
, resticprofile adds its AppName to the config dir paths.

Also add %USERPROFILE%\AppData\Roaming\resticprofile, which should be included in the paths returned by xdg.ConfigDirs (see https://github.com/adrg/xdg/blob/d8917aeea69ad0645ce98b2a1e3edb5cab67199a/paths_windows.go#L22).

Finally, I added a note to clarify that these paths can be overridden if the XDG environment variables are set.

@auxym
Correct configuration search paths on Windows
831bd7e 
Append `restoicprofile` to the AppData and ProgramData paths on Windows
See https://github.com/creativeprojects/resticprofile/blob/ac3b810f2f735642d0a0cea8ec46c585b80904bc/filesearch/filesearch.go#L224, resticprofile adds
its AppName to the config dir paths.

Also add `%USERPROFILE%\AppData\Roaming\resticprofile`, which should be
included in the paths returned by `xdg.ConfigDirs` (see https://github.com/adrg/xdg/blob/d8917aeea69ad0645ce98b2a1e3edb5cab67199a/paths_windows.go#L22).

Finally, I added a note to clarify that these paths can be overridden if
the XDG environment variables are set.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Mar 30, 2025 •
edited
Loading

Walkthrough

The changes update the documentation for configuration file search paths on Windows. The previous generic paths have been replaced with more specific user-based paths. Additionally, a note has been added to indicate that these paths may be overridden by the XDG_CONFIG_HOME or XDG_CONFIG_DIRS environment variables.

Changes

File Change Summary
docs/.../path.md Updated Windows configuration paths by replacing %USERPROFILE%\AppData\Local\ with %USERPROFILE%\AppData\Local\resticprofile, %USERPROFILE%\AppData\Roaming\resticprofile, and c:\ProgramData\ with c:\ProgramData\resticprofile. Also, %USERPROFILE%\ is now %USERPROFILE%\resticprofile and a new note has been added about overriding these via XDG_CONFIG_HOME/XDG_CONFIG_DIRS.

Possibly related PRs

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 1b05c7a and 831bd7e.

📒 Files selected for processing (1)
  • docs/content/configuration/path.md (1 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
docs/content/configuration/path.md

156-156: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

157-157: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

158-158: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

159-159: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

160-160: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

161-161: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

🔇 Additional comments (3)
docs/content/configuration/path.md (3)

156-158: Update Windows Paths with AppName
The new paths %USERPROFILE%\AppData\Local\resticprofile, %USERPROFILE%\AppData\Roaming\resticprofile, and c:\ProgramData\resticprofile now correctly include the application name as required by the PR objectives.
However, static analysis (MD004) suggests that unordered list items should use asterisks instead of dashes. You might consider updating these lines for consistency.

- - %USERPROFILE%\AppData\Local\resticprofile
- - %USERPROFILE%\AppData\Roaming\resticprofile
- - c:\ProgramData\resticprofile
+ * %USERPROFILE%\AppData\Local\resticprofile
+ * %USERPROFILE%\AppData\Roaming\resticprofile
+ * c:\ProgramData\resticprofile

[suggest_nitpick, approve_code_changes]

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

156-156: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

157-157: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

158-158: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

161-161: Additional Fallback Path Consideration
The inclusion of %USERPROFILE%\resticprofile provides an extra fallback directory. Ensure that its purpose is clearly documented as distinct from the AppData paths. Also, as with the other list items, consider using asterisks for a consistent markdown style.

- - %USERPROFILE%\resticprofile
+ * %USERPROFILE%\resticprofile

[suggest_nitpick, approve_code_changes]

🧰 Tools
🪛 markdownlint-cli2 (0.17.2)

161-161: Unordered list style
Expected: asterisk; Actual: dash

(MD004, ul-style)

163-164: Clarification on Environment Variable Overrides
The new note indicating that these paths may be overridden by setting the XDG_CONFIG_HOME or XDG_CONFIG_DIRS environment variables is clear and useful. It aligns well with the intended flexibility for Windows users. For further clarity, you might consider adding an inline reference or link to the relevant section of the xdg library documentation.

[suggest_good_to_have_refactor, approve_code_changes]

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@creativeprojects
Copy link
Copy Markdown
Owner

creativeprojects commented Mar 30, 2025

Well spotted, the documentation was definitely outdated.

Thank you very much for the PR 👍🏻

(the documentation will be updated on the next release, possibly today or in the next few days)

@creativeprojects creativeprojects merged commit f14094b into creativeprojects:master Mar 30, 2025
4 checks passed
@coderabbitai coderabbitai Bot mentioned this pull request Jun 6, 2025
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@auxym @creativeprojects